RAIS  3.2
RAIS::ApplicationLogicLayer::TableManagement Class Reference

This class implements A.L.L. methods for table managements. More...

List of all members.

Static Public Member Functions

static bool IsEmptyFelds (string tableName, string fieldName)
 This method checks is empty field.
static void InitializeDAL ()
static Tables GetCustomTablesByGroup (TableGroup tableGroup)
 This property retrieves a list of all available custom tables.
static Tables GetTablesByGroup (TableGroup tableGroup, bool showProtectors, bool showEvaluators)
 This property retrieves a list of all available tables by table group.
static Table GetTableByTableID (int id)
 This method retrieves from DB table object by table id.
static bool AddTable (Table table, TableGroup tableGroup, string maskName, int subcategoryID, DynamicMask.DynamicMaskType?dynamicMaskType, string dynamicMaskName, bool addForeignKeyField, bool createDymamicMask, ref string returnMessage)
 This method creates a new table in DB.
static bool AddField (Table table, Field field, ref string returnMessage)
 This method adds new record in Field table.
static bool RemoveTable (Table table, ref string returnMessage)
 This method removes a table from DB.
static bool SaveCustomTable (Table table, ref string returnMessage)
 This method saves table modifications through DAL.
static bool SaveFieldOrder (Field field, ref string returnMessage)
 This method saves new field order in Field table.
static bool SaveFieldQueryName (Field field, ref string returnMessage)
 This method saves new field Query Name in Field table.
static bool SaveField (Field field, ref string returnMessage)
 This method saves changes in Field table.
static bool RemoveField (Field field, ref string returnMessage)
 This method removes record from Field table.
static Fields GetLookupFieldsByTable (Table table)
 This method retrieves from DB lookup field names for the specified table.
static Fields GetTextFieldsByTable (Table table)
 This method retrieves from DB text field names for the specified table.
static Fields GetFieldsByTable (Table table)
 This method retrieves from DB field names for the specified table.
static XmlDocument GetTableAndFieldXml ()
 This method creates script for tables creation.
static FieldSizes GetFieldSizesByFieldType (Field.FieldType fieldType)
 This method retrieves field sizes for field type.
static Queries GetQueries ()
 This method retrieves from DB query names.
static Queries GetQueriesByCustomizationType (Query.CustomizationType customizationType)
 This method retrieves from DB query names by customization type.
static Queries GetQueriesByQueryType (Query.QueryType queryType)
 This method retrieves from DB query names.
static bool AddQuery (Query query, ref string returnMessage)
 This method adds new record in Query table.
static bool SaveQuery (Query query, ref string returnMessage)
 This method saves record into Query table.
static bool RemoveQuery (Query query, ref string returnMessage)
 This method removes record from Query table.
static bool ValidateQueryParameters (Query query, ref string returnMessage)
 This method validates the CustomQuery parameters and returns the result of the validateion.
static bool CreateQuery (Query query, ref string returnMessage)
 This method creates the SQL function for the CustomQuery and return the result of the creation.
static bool CheckQuery (Query query, ref string returnMessage)
 This method checks the CustomQuery SQL text and return the result of the check.
static QueryParameterTypes GetQueryParameterTypesByQuery (Query query)
 This method retrieves a list of query parameter types dependently on query type.
static QueryParameters GetQueryParametersByQuery (Query query)
 This method retrieves from DB query parameters for the specified query.
static bool AddQueryParameter (Query query, QueryParameter queryParameter, ref string returnMessage)
 This method adds new record in [Query Parameter] table.
static bool SaveQueryParameter (QueryParameter queryParameter, ref string returnMessage)
 This method saves changes into [Query Parameter] table.
static bool SaveQueryParameterOrder (QueryParameter queryParameter, ref string returnMessage)
 This method saves new query parameter order in [Query Parameter] table.
static bool RemoveQueryParameter (QueryParameter queryParameter, ref string returnMessage)
 This method removes record from [Query Parameter] table.
static CustomizationTypes GetCustomizationTypes ()
 This method returns Customization Types.
static bool CreateHistoryTable (Table table, ref string returnMessage)
 This method creates history table for selected table.
static List< string > GetQueryAssignedObjectsNames (Query query)
 This method retrieves from DB query assigned objects names.
static bool IsTableContainData (Table table)
 This method checks is table contain data.

Properties

static FieldTypes FieldTypes [get]
 This property retrieves a list of all available field types.
static FieldSizes FieldSizes [get]
 This property retrieves a list of all available field sizes/formats types.
static NecessityTypes NecessityTypes [get]
 This property retrieves a list of all available field necessity types.
static TableTypes TableTypes [get]
 This property retrieves a list of all available table types.
static TableGroups TableGroups [get]
 This property retrieves a list of all available table groups.
static Tables AllTables [get]
 This property retrieves a list of all available tables.
static QueryTypes QueryTypes [get]
 This property retrieves a list of all available query types.

Detailed Description

This class implements A.L.L. methods for table managements.


Member Function Documentation

static bool RAIS::ApplicationLogicLayer::TableManagement::AddField ( Table  table,
Field  field,
ref string  returnMessage 
) [static]

This method adds new record in Field table.

Parameters:
tableobject for new field.
fieldobject to be added into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 128 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::AddQuery ( Query  query,
ref string  returnMessage 
) [static]

This method adds new record in Query table.

Parameters:
queryobject to be added into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 321 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::AddQueryParameter ( Query  query,
QueryParameter  queryParameter,
ref string  returnMessage 
) [static]

This method adds new record in [Query Parameter] table.

Parameters:
queryobject to add parameter to
queryParameterobject to be added into DB
returnMessageMessage string about the action result
Returns:
true on success, otherwise false;

Definition at line 445 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::AddTable ( Table  table,
TableGroup  tableGroup,
string  maskName,
int  subcategoryID,
DynamicMask.DynamicMaskType?  dynamicMaskType,
string  dynamicMaskName,
bool  addForeignKeyField,
bool  createDymamicMask,
ref string  returnMessage 
) [static]

This method creates a new table in DB.

Parameters:
tableobject to be added into DB.
tableGroupobject for new table.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 117 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::CheckQuery ( Query  query,
ref string  returnMessage 
) [static]

This method checks the CustomQuery SQL text and return the result of the check.

Parameters:
queryobject to check the query text.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 400 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::CreateHistoryTable ( Table  table,
ref string  returnMessage 
) [static]

This method creates history table for selected table.

Parameters:
tableobject to be added into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 502 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::CreateQuery ( Query  query,
ref string  returnMessage 
) [static]

This method creates the SQL function for the CustomQuery and return the result of the creation.

Parameters:
queryobject to check the query text.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 390 of file TableManagement.cs.

static CustomizationTypes RAIS::ApplicationLogicLayer::TableManagement::GetCustomizationTypes ( ) [static]

This method returns Customization Types.

Returns:
Customization Types object

Definition at line 483 of file TableManagement.cs.

static Tables RAIS::ApplicationLogicLayer::TableManagement::GetCustomTablesByGroup ( TableGroup  tableGroup) [static]

This property retrieves a list of all available custom tables.

Returns:
Dictionary of table names vs table objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 84 of file TableManagement.cs.

static Fields RAIS::ApplicationLogicLayer::TableManagement::GetFieldsByTable ( Table  table) [static]

This method retrieves from DB field names for the specified table.

Parameters:
tableTable.
Returns:
dictionary of field names vs Field objects

Definition at line 265 of file TableManagement.cs.

static FieldSizes RAIS::ApplicationLogicLayer::TableManagement::GetFieldSizesByFieldType ( Field.FieldType  fieldType) [static]

This method retrieves field sizes for field type.

Returns:
true on success, otherwise false;

Definition at line 283 of file TableManagement.cs.

static Fields RAIS::ApplicationLogicLayer::TableManagement::GetLookupFieldsByTable ( Table  table) [static]

This method retrieves from DB lookup field names for the specified table.

Parameters:
tableTable.
Returns:
dictionary of field names vs Field objects

Definition at line 229 of file TableManagement.cs.

static Queries RAIS::ApplicationLogicLayer::TableManagement::GetQueries ( ) [static]

This method retrieves from DB query names.

Returns:
dictionary of query names vs Query objects

Definition at line 292 of file TableManagement.cs.

static Queries RAIS::ApplicationLogicLayer::TableManagement::GetQueriesByCustomizationType ( Query.CustomizationType  customizationType) [static]

This method retrieves from DB query names by customization type.

Returns:
dictionary of query names vs Query objects

Definition at line 301 of file TableManagement.cs.

static Queries RAIS::ApplicationLogicLayer::TableManagement::GetQueriesByQueryType ( Query.QueryType  queryType) [static]

This method retrieves from DB query names.

Returns:
dictionary of query names vs Query objects

Definition at line 311 of file TableManagement.cs.

static List<string> RAIS::ApplicationLogicLayer::TableManagement::GetQueryAssignedObjectsNames ( Query  query) [static]

This method retrieves from DB query assigned objects names.

Parameters:
queryobject to get assigned objects to
Returns:
list of objects names

Definition at line 511 of file TableManagement.cs.

static QueryParameters RAIS::ApplicationLogicLayer::TableManagement::GetQueryParametersByQuery ( Query  query) [static]

This method retrieves from DB query parameters for the specified query.

Parameters:
queryQuery.
Returns:
dictionary of query parameter names vs QueryParameter objects

Definition at line 434 of file TableManagement.cs.

static QueryParameterTypes RAIS::ApplicationLogicLayer::TableManagement::GetQueryParameterTypesByQuery ( Query  query) [static]

This method retrieves a list of query parameter types dependently on query type.

Parameters:
queryTypeQueryType.
Returns:
Dictionary of query parameter type names vs query parameter type objects

Definition at line 409 of file TableManagement.cs.

static XmlDocument RAIS::ApplicationLogicLayer::TableManagement::GetTableAndFieldXml ( ) [static]

This method creates script for tables creation.

Returns:
true on success, otherwise false;

Definition at line 274 of file TableManagement.cs.

static Table RAIS::ApplicationLogicLayer::TableManagement::GetTableByTableID ( int  id) [static]

This method retrieves from DB table object by table id.

Returns:
Table object

Definition at line 106 of file TableManagement.cs.

static Tables RAIS::ApplicationLogicLayer::TableManagement::GetTablesByGroup ( TableGroup  tableGroup,
bool  showProtectors,
bool  showEvaluators 
) [static]

This property retrieves a list of all available tables by table group.

Returns:
Dictionary of table names vs table objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 95 of file TableManagement.cs.

static Fields RAIS::ApplicationLogicLayer::TableManagement::GetTextFieldsByTable ( Table  table) [static]

This method retrieves from DB text field names for the specified table.

Parameters:
tableTable.
Returns:
dictionary of field names vs Field objects

Definition at line 247 of file TableManagement.cs.

static void RAIS::ApplicationLogicLayer::TableManagement::InitializeDAL ( ) [static]

This method checks Initialize Data access layer.

Definition at line 73 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::IsEmptyFelds ( string  tableName,
string  fieldName 
) [static]

This method checks is empty field.

Parameters:
tableNameTable name
fieldNameFiled name
Returns:
Is field contain data

Definition at line 66 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::IsTableContainData ( Table  table) [static]

This method checks is table contain data.

Parameters:
tableTable name
Returns:
Is table contain data

Definition at line 520 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::RemoveField ( Field  field,
ref string  returnMessage 
) [static]

This method removes record from Field table.

Parameters:
fieldobject to be removed from DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 220 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::RemoveQuery ( Query  query,
ref string  returnMessage 
) [static]

This method removes record from Query table.

Parameters:
queryobject to be removed from DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 341 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::RemoveQueryParameter ( QueryParameter  queryParameter,
ref string  returnMessage 
) [static]

This method removes record from [Query Parameter] table.

Parameters:
queryParameterobject to be removed from DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 475 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::RemoveTable ( Table  table,
ref string  returnMessage 
) [static]

This method removes a table from DB.

Parameters:
tableTable object to be removed from DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 138 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::SaveCustomTable ( Table  table,
ref string  returnMessage 
) [static]

This method saves table modifications through DAL.

Parameters:
tabletable object.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 149 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::SaveField ( Field  field,
ref string  returnMessage 
) [static]

This method saves changes in Field table.

Parameters:
fieldobject to be saved into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 210 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::SaveFieldOrder ( Field  field,
ref string  returnMessage 
) [static]

This method saves new field order in Field table.

Parameters:
fieldobject to be saved into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 190 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::SaveFieldQueryName ( Field  field,
ref string  returnMessage 
) [static]

This method saves new field Query Name in Field table.

Parameters:
fieldobject to be saved into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 200 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::SaveQuery ( Query  query,
ref string  returnMessage 
) [static]

This method saves record into Query table.

Parameters:
queryobject to be saved into DB.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 331 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::SaveQueryParameter ( QueryParameter  queryParameter,
ref string  returnMessage 
) [static]

This method saves changes into [Query Parameter] table.

Parameters:
queryParameterobject to be saved into DB
returnMessageMessage string about the action result
Returns:
true on success, otherwise false;

Definition at line 455 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::SaveQueryParameterOrder ( QueryParameter  queryParameter,
ref string  returnMessage 
) [static]

This method saves new query parameter order in [Query Parameter] table.

Parameters:
queryParameterobject to be saved into DB
returnMessageMessage string about the action result
Returns:
true on success, otherwise false;

Definition at line 465 of file TableManagement.cs.

static bool RAIS::ApplicationLogicLayer::TableManagement::ValidateQueryParameters ( Query  query,
ref string  returnMessage 
) [static]

This method validates the CustomQuery parameters and returns the result of the validateion.

Parameters:
queryobject to check the query text.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 351 of file TableManagement.cs.


Property Documentation

Tables RAIS::ApplicationLogicLayer::TableManagement::AllTables [static, get]

This property retrieves a list of all available tables.

Returns:
Dictionary of table names vs table objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 590 of file TableManagement.cs.

FieldSizes RAIS::ApplicationLogicLayer::TableManagement::FieldSizes [static, get]

This property retrieves a list of all available field sizes/formats types.

Returns:
Dictionary of field size/format names vs field size/format objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 546 of file TableManagement.cs.

FieldTypes RAIS::ApplicationLogicLayer::TableManagement::FieldTypes [static, get]

This property retrieves a list of all available field types.

Returns:
Dictionary of field type names vs field type objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 535 of file TableManagement.cs.

NecessityTypes RAIS::ApplicationLogicLayer::TableManagement::NecessityTypes [static, get]

This property retrieves a list of all available field necessity types.

Returns:
Dictionary of field necessity names vs field necessity objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 557 of file TableManagement.cs.

QueryTypes RAIS::ApplicationLogicLayer::TableManagement::QueryTypes [static, get]

This property retrieves a list of all available query types.

Returns:
Dictionary of query type names vs query type objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 601 of file TableManagement.cs.

TableGroups RAIS::ApplicationLogicLayer::TableManagement::TableGroups [static, get]

This property retrieves a list of all available table groups.

Returns:
Dictionary of table group names vs table group objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 579 of file TableManagement.cs.

TableTypes RAIS::ApplicationLogicLayer::TableManagement::TableTypes [static, get]

This property retrieves a list of all available table types.

Returns:
Dictionary of table type names vs table type objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 568 of file TableManagement.cs.


The documentation for this class was generated from the following file: